home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3c / catgetmsg.z / catgetmsg
Encoding:
Text File  |  2002-10-03  |  4.0 KB  |  67 lines
  1.  
  2.  
  3.  
  4. ccccaaaattttggggeeeettttmmmmssssgggg((((3333CCCC))))                                                    ccccaaaattttggggeeeettttmmmmssssgggg((((3333CCCC))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      catgetmsg - reads a message from a message catalog
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_nnnn_llll______tttt_yyyy_pppp_eeee_ssss_...._hhhh_>>>>
  13.  
  14.      _cccc_hhhh_aaaa_rrrr _****_cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg (_nnnn_llll______cccc_aaaa_tttt_dddd _c_a_t_d_,,,, _iiii_nnnn_tttt _s_e_t__n_u_m_,,,, _iiii_nnnn_tttt _m_s_g__n_u_m_,,,, _cccc_hhhh_aaaa_rrrr _((((_****_b_u_f_,,,, _iiii_nnnn_tttt _b_u_f_l_e_n_))))_;;;;
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      The _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg function returns the requested message string.  The message
  18.      string is placed in the user-supplied buffer (pointed to by _b_u_f) and
  19.      terminated with a null byte.  If the message is longer than _b_u_f_l_e_n bytes,
  20.      it is truncated with a null byte.
  21.  
  22.      The _c_a_t_d argument is a catalog descriptor returned from an earlier call
  23.      to _cccc_aaaa_tttt_oooo_pppp_eeee_nnnn(3C); it identifies the message catalog that contains the
  24.      message identified by the message set (_s_e_t__n_u_m) and the message number
  25.      (_m_s_g__n_u_m).
  26.  
  27.      The _s_e_t__n_u_m and _m_s_g__n_u_m arguments are defined as integer values for
  28.      maximum portability.  However, it is recommended that programmers use
  29.      symbolic names for message and set numbers wherever possible, rather than
  30.      having integer values hard-coded into their source programs.  The
  31.      _NNNN_LLLL______MMMM_SSSS_GGGG_SSSS_EEEE_TTTT macro in the _nnnn_llll______tttt_yyyy_pppp_eeee_ssss_...._hhhh file must be passed as the _s_e_t__n_u_m
  32.      argument.
  33.  
  34. NNNNOOOOTTTTEEEESSSS
  35.      You can use the _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg and _cccc_aaaa_tttt_gggg_eeee_tttt_ssss(3C) functions to retrieve messages
  36.      from a message catalog.  _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg and _cccc_aaaa_tttt_gggg_eeee_tttt_ssss have comparable
  37.      performance.
  38.  
  39.      Specifically, _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg minimizes memory usage at the expense of more
  40.      frequent disk accesses.  The _cccc_aaaa_tttt_gggg_eeee_tttt_ssss(3C) function minimizes disk accesses
  41.      at the expense of more memory usage.  If it is important to your
  42.      application to minimize usage of one of these resources, use the
  43.      corresponding function.
  44.  
  45. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  46.      If successful, _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg returns a pointer to the message string in _b_u_f.
  47.  
  48.      If _cccc_aaaa_tttt_gggg_eeee_tttt_mmmm_ssss_gggg is unsuccessful because the message catalog identified by
  49.      _c_a_t_d is not currently available, or the requested message is not in the
  50.      message catalog, a pointer to a null ("") string is returned.
  51.  
  52. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  53.      caterr(1), explain(1), gencat(1), catgets(3C), catmsgfmt(3C),
  54.      catopen(3C), nl_types(5).
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.